<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationRegistry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="InfCommunicationMethod.html" title="InfCommunicationMethod">
<link rel="next" href="InfCommunicationCentralFactory.html" title="InfCommunicationCentralFactory">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfCommunicationMethod.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfCommunicationCentralFactory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfCommunicationRegistry.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfCommunicationRegistry.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfCommunicationRegistry.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="InfCommunicationRegistry">
<a name="InfCommunicationRegistry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationRegistry.top_of_page"></a>InfCommunicationRegistry</span></h2>
<p>InfCommunicationRegistry — Sharing connections between multiple groups</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfCommunicationRegistry.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfCommunicationRegistry.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/communication/inf-communication-registry.h&gt;

                    <a class="link" href="InfCommunicationRegistry.html#InfCommunicationRegistry-struct" title="InfCommunicationRegistry">InfCommunicationRegistry</a>;
                    <a class="link" href="InfCommunicationRegistry.html#InfCommunicationRegistryClass" title="InfCommunicationRegistryClass">InfCommunicationRegistryClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()">inf_communication_registry_register</a> (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-unregister" title="inf_communication_registry_unregister ()">inf_communication_registry_unregister</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-is-registered" title="inf_communication_registry_is_registered ()">inf_communication_registry_is_registered</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()">inf_communication_registry_send</a>     (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()">inf_communication_registry_cancel_messages</a>
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfCommunicationRegistry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfCommunicationRegistry
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfCommunicationRegistry.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> provides a way for <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>
implementations to share connections with other groups. Before using a
connection, call <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>. Then, messages can
be sent to the group via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a>.
</p>
<p>
The <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> calls <a class="link" href="InfCommunicationMethod.html#inf-communication-method-received" title="inf_communication_method_received ()"><code class="function">inf_communication_method_received()</code></a>
on your method when it received a message for the group,
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-enqueued" title="inf_communication_method_enqueued ()"><code class="function">inf_communication_method_enqueued()</code></a> when sending the message cannot be
cancelled anymore via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()"><code class="function">inf_communication_registry_cancel_messages()</code></a> and
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-sent" title="inf_communication_method_sent ()"><code class="function">inf_communication_method_sent()</code></a> when the message has been sent.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfCommunicationRegistry.details"></a><h2>Details</h2>
<div class="refsect2" title="InfCommunicationRegistry">
<a name="InfCommunicationRegistry-struct"></a><h3>InfCommunicationRegistry</h3>
<pre class="programlisting">typedef struct _InfCommunicationRegistry InfCommunicationRegistry;</pre>
<p>
<a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> is an opaque data type. You should only access it
via the public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="InfCommunicationRegistryClass">
<a name="InfCommunicationRegistryClass"></a><h3>InfCommunicationRegistryClass</h3>
<pre class="programlisting">typedef struct {
} InfCommunicationRegistryClass;
</pre>
<p>
This structure does not contain any public fields.
</p>
</div>
<hr>
<div class="refsect2" title="inf_communication_registry_register ()">
<a name="inf-communication-registry-register"></a><h3>inf_communication_registry_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_registry_register (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Registers connection with <em class="parameter"><code>group</code></em>. This allows sending messages to
<em class="parameter"><code>connection</code></em> via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a>. For received messages,
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-received" title="inf_communication_method_received ()"><code class="function">inf_communication_method_received()</code></a> is called on <em class="parameter"><code>method</code></em>.
</p>
<p>
<em class="parameter"><code>connection</code></em> must have status <code class="literal">INF_XML_CONNECTION_OPEN</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>The group for which to register a connection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>The <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> used.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The connection to register.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_registry_unregister ()">
<a name="inf-communication-registry-unregister"></a><h3>inf_communication_registry_unregister ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_registry_unregister
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Unregisters <em class="parameter"><code>connection</code></em> from <em class="parameter"><code>group</code></em>. Incoming messages are no longer
reported to group's method, and <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a> can
no longer be called for <em class="parameter"><code>connection</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>The group for which to unregister a connection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The connection to unregister.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_registry_is_registered ()">
<a name="inf-communication-registry-is-registered"></a><h3>inf_communication_registry_is_registered ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_communication_registry_is_registered
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>connection</code></em> has been registered for <em class="parameter"><code>group</code></em> with
<a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>The group for which to check whether <em class="parameter"><code>connection</code></em> is registered.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>The connection to check for registration.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>connection</code></em> has been registered, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_registry_send ()">
<a name="inf-communication-registry-send"></a><h3>inf_communication_registry_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_registry_send     (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>
Sends an XML message to <em class="parameter"><code>connection</code></em>. <em class="parameter"><code>connection</code></em> must have been registered
with <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a> before. If the message has been
sent, <a class="link" href="InfCommunicationMethod.html#inf-communication-method-sent" title="inf_communication_method_sent ()"><code class="function">inf_communication_method_sent()</code></a> is called on the method the
connection was registered with. <a class="link" href="InfCommunicationMethod.html#inf-communication-method-enqueued" title="inf_communication_method_enqueued ()"><code class="function">inf_communication_method_enqueued()</code></a> is
called when sending the message can no longer be cancelled via
<a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()"><code class="function">inf_communication_registry_cancel_messages()</code></a>.
</p>
<p>
This function takes ownership of <em class="parameter"><code>xml</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>The group for which to send the message <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A registered <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xml</code></em> :</span></p></td>
<td>The message to send.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_communication_registry_cancel_messages ()">
<a name="inf-communication-registry-cancel-messages"></a><h3>inf_communication_registry_cancel_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_communication_registry_cancel_messages
                                                        (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Stops all messages scheduled to be sent to <em class="parameter"><code>connection</code></em> in <em class="parameter"><code>group</code></em> from being
sent.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>registry</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>The group for which to cancel messages.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A registered <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>